// Copyright (c) 2017 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package definition

import "github.com/uber/cadence/common/types"

// valid indexed fields on ES
const (
	DomainID              = "DomainID"
	WorkflowID            = "WorkflowID"
	RunID                 = "RunID"
	WorkflowType          = "WorkflowType"
	StartTime             = "StartTime"
	ExecutionTime         = "ExecutionTime"
	CloseTime             = "CloseTime"
	CloseStatus           = "CloseStatus"
	HistoryLength         = "HistoryLength"
	Encoding              = "Encoding"
	KafkaKey              = "KafkaKey"
	BinaryChecksums       = "BinaryChecksums"
	TaskList              = "TaskList"
	ClusterAttributeScope = "ClusterAttributeScope"
	ClusterAttributeName  = "ClusterAttributeName"
	IsCron                = "IsCron"
	NumClusters           = "NumClusters"
	UpdateTime            = "UpdateTime"
	CustomDomain          = "CustomDomain" // to support batch workflow
	Operator              = "Operator"     // to support batch workflow

	CustomStringField    = "CustomStringField"
	CustomKeywordField   = "CustomKeywordField"
	CustomIntField       = "CustomIntField"
	CustomBoolField      = "CustomBoolField"
	CustomDoubleField    = "CustomDoubleField"
	CustomDatetimeField  = "CustomDatetimeField"
	CadenceChangeVersion = "CadenceChangeVersion"
)

const (
	// Memo is valid non-indexed fields on ES
	Memo = "Memo"
	// Attr is prefix of custom search attributes
	Attr = "Attr"
	// HeaderFormat is the format of context headers in search attributes
	HeaderFormat = "Header_%s"
)

// defaultIndexedKeys defines all searchable keys
var defaultIndexedKeys = createDefaultIndexedKeys()

func createDefaultIndexedKeys() map[string]interface{} {
	defaultIndexedKeys := map[string]interface{}{
		CustomStringField:    types.IndexedValueTypeString,
		CustomKeywordField:   types.IndexedValueTypeKeyword,
		CustomIntField:       types.IndexedValueTypeInt,
		CustomBoolField:      types.IndexedValueTypeBool,
		CustomDoubleField:    types.IndexedValueTypeDouble,
		CustomDatetimeField:  types.IndexedValueTypeDatetime,
		CadenceChangeVersion: types.IndexedValueTypeKeyword,
		BinaryChecksums:      types.IndexedValueTypeKeyword,
		CustomDomain:         types.IndexedValueTypeString,
		Operator:             types.IndexedValueTypeString,
	}
	for k, v := range systemIndexedKeys {
		defaultIndexedKeys[k] = v
	}
	return defaultIndexedKeys
}

// GetDefaultIndexedKeys return default valid indexed keys
func GetDefaultIndexedKeys() map[string]interface{} {
	return defaultIndexedKeys
}

// systemIndexedKeys is Cadence created visibility keys
var systemIndexedKeys = map[string]interface{}{
	DomainID:              types.IndexedValueTypeKeyword,
	WorkflowID:            types.IndexedValueTypeKeyword,
	RunID:                 types.IndexedValueTypeKeyword,
	WorkflowType:          types.IndexedValueTypeKeyword,
	StartTime:             types.IndexedValueTypeInt,
	ExecutionTime:         types.IndexedValueTypeInt,
	CloseTime:             types.IndexedValueTypeInt,
	CloseStatus:           types.IndexedValueTypeInt,
	HistoryLength:         types.IndexedValueTypeInt,
	TaskList:              types.IndexedValueTypeKeyword,
	IsCron:                types.IndexedValueTypeBool,
	NumClusters:           types.IndexedValueTypeInt,
	UpdateTime:            types.IndexedValueTypeInt,
	ClusterAttributeScope: types.IndexedValueTypeKeyword,
	ClusterAttributeName:  types.IndexedValueTypeKeyword,
}

// IsSystemIndexedKey return true is key is system added
func IsSystemIndexedKey(key string) bool {
	_, ok := systemIndexedKeys[key]
	return ok
}

// IsSystemBoolKey return true is key is system added bool key
func IsSystemBoolKey(key string) bool {
	return systemIndexedKeys[key] == types.IndexedValueTypeBool
}
